Get interactive lab details [single]

POST

public

get-lab-details

curl --request POST \
  --url https://backend.codedamn.com/api/public/get-lab-details \
  --header 'Content-Type: application/json' \
  --header 'FERMION-API-KEY: <api-key>' \
  --data '
{
  "data": [
    {
      "data": {
        "labId": "<string>"
      }
    }
  ]
}
'

[
  {
    "output": {
      "status": "ok",
      "data": {
        "labTitle": "<string>",
        "labDescriptionMarkdown": "<string>",
        "defaultGitRepositoryUrl": "<string>",
        "defaultGitRepositoryBranchName": "<string>",
        "evaluationScriptBashCommand": "<string>",
        "evaluationScriptTestFileContent": "<string>",
        "testCases": [
          {
            "testCaseId": "<string>",
            "type": "SelfEvaluative",
            "markdownLabel": "<string>",
            "markdownHint": "<string>"
          }
        ]
      }
    }
  }
]

Authorizations

FERMION-API-KEY

string

header

required

Body

application/json

API Request Body

data

object[]

required

Show child attributes

data.data

object

required

Show child attributes

data.data.labId

string

required

ID of lab as specified in your fermion dashboard

Minimum string length: 1

Response

200 - application/json

API Response Body

output

object

required

Option 1
Option 2

Show child attributes

output.status

enum<string>

required

Available options:

ok

output.data

object

required

Show child attributes

output.data.labTitle

string

required

Title of the lab

output.data.labDescriptionMarkdown

string

required

Description of the lab in markdown format

output.data.defaultGitRepositoryUrl

required

URL of the default Git repository to clone for this lab. Null if no repository is configured

output.data.defaultGitRepositoryBranchName

required

Branch name to checkout from the default Git repository. Null if no specific branch is configured

output.data.evaluationScriptBashCommand

required

Bash command to run for evaluating the lab submission (e.g., "npm test"). Null if no evaluation command is set

output.data.evaluationScriptTestFileContent

required

Content of the test file used for evaluation. Null if no test file is configured

output.data.testCases

object[]

required

Array of test cases/challenges that students need to complete in this lab

Show child attributes

output.data.testCases.testCaseId

string

required

Unique identifier for this test case

Minimum string length: 1

output.data.testCases.type

enum<string>

required

Type of challenge (e.g., unit test, functional test)

Available options:

SelfEvaluative,

SystemEvaluative

output.data.testCases.markdownLabel

string

required

Display label for the test case in markdown format

Minimum string length: 1

output.data.testCases.markdownHint

required

Optional hint text for the test case in markdown format. Null if no hint is provided

List all interactive labs Get a list of all interactive labs from the school's private library Authentication with the "FERMION-API-KEY" header is required to use this endpoint. Rate limit: Maximum 60 requests in a window of 1m.

⌘I

Get interactive lab details [single]

curl --request POST \
  --url https://backend.codedamn.com/api/public/get-lab-details \
  --header 'Content-Type: application/json' \
  --header 'FERMION-API-KEY: <api-key>' \
  --data '
{
  "data": [
    {
      "data": {
        "labId": "<string>"
      }
    }
  ]
}
'

[
  {
    "output": {
      "status": "ok",
      "data": {
        "labTitle": "<string>",
        "labDescriptionMarkdown": "<string>",
        "defaultGitRepositoryUrl": "<string>",
        "defaultGitRepositoryBranchName": "<string>",
        "evaluationScriptBashCommand": "<string>",
        "evaluationScriptTestFileContent": "<string>",
        "testCases": [
          {
            "testCaseId": "<string>",
            "type": "SelfEvaluative",
            "markdownLabel": "<string>",
            "markdownHint": "<string>"
          }
        ]
      }
    }
  }
]

Using API

Endpoints

Get interactive lab details [single]

Authorizations

Body

Response